Audits

Retrieve Audits Search

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Audits Search

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/audits/search?scope=&query=&filters[created]=&filters[actor_email][]=&filters[actor_type]=&filters[auditable_type]=&filters[auditable_uid]=&filters[verb]="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuditsApi;

import java.io.File;
import java.util.*;

public class AuditsApiExample {

    public static void main(String[] args) {
        
        AuditsApi apiInstance = new AuditsApi();
        String scope = scope_example; // String | 
        String query = query_example; // String | 
        Date filters[created] = 2013-10-20T19:20:30+01:00; // Date | 
        array[String] filters[actorEmail][] = ; // array[String] | 
        String filters[actorType] = filters[actorType]_example; // String | 
        String filters[auditableType] = filters[auditableType]_example; // String | 
        String filters[auditableUid] = filters[auditableUid]_example; // String | 
        String filters[verb] = filters[verb]_example; // String | 
        try {
            audit result = apiInstance.auditsSearchGet(scope, query, filters[created], filters[actorEmail][], filters[actorType], filters[auditableType], filters[auditableUid], filters[verb]);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditsApi#auditsSearchGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AuditsApi;

public class AuditsApiExample {

    public static void main(String[] args) {
        AuditsApi apiInstance = new AuditsApi();
        String scope = scope_example; // String | 
        String query = query_example; // String | 
        Date filters[created] = 2013-10-20T19:20:30+01:00; // Date | 
        array[String] filters[actorEmail][] = ; // array[String] | 
        String filters[actorType] = filters[actorType]_example; // String | 
        String filters[auditableType] = filters[auditableType]_example; // String | 
        String filters[auditableUid] = filters[auditableUid]_example; // String | 
        String filters[verb] = filters[verb]_example; // String | 
        try {
            audit result = apiInstance.auditsSearchGet(scope, query, filters[created], filters[actorEmail][], filters[actorType], filters[auditableType], filters[auditableUid], filters[verb]);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditsApi#auditsSearchGet");
            e.printStackTrace();
        }
    }
}

String *scope = scope_example; //  (optional) (default to audit)
String *query = query_example; //  (optional)
Date *filters[created] = 2013-10-20T19:20:30+01:00; //  (optional)
array[String] *filters[actorEmail][] = ; //  (optional)
String *filters[actorType] = filters[actorType]_example; //  (optional)
String *filters[auditableType] = filters[auditableType]_example; //  (optional)
String *filters[auditableUid] = filters[auditableUid]_example; //  (optional)
String *filters[verb] = filters[verb]_example; //  (optional)

AuditsApi *apiInstance = [[AuditsApi alloc] init];

[apiInstance auditsSearchGetWith:scope
    query:query
    filters[created]:filters[created]
    filters[actorEmail][]:filters[actorEmail][]
    filters[actorType]:filters[actorType]
    filters[auditableType]:filters[auditableType]
    filters[auditableUid]:filters[auditableUid]
    filters[verb]:filters[verb]
              completionHandler: ^(audit output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.AuditsApi()
var opts = { 
  'scope': scope_example, // {{String}} 
  'query': query_example, // {{String}} 
  'filters[created]': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'filters[actorEmail][]': , // {{array[String]}} 
  'filters[actorType]': filters[actorType]_example, // {{String}} 
  'filters[auditableType]': filters[auditableType]_example, // {{String}} 
  'filters[auditableUid]': filters[auditableUid]_example, // {{String}} 
  'filters[verb]': filters[verb]_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.auditsSearchGet(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class auditsSearchGetExample
    {
        public void main()
        {

            var apiInstance = new AuditsApi();
            var scope = scope_example;  // String |  (optional)  (default to audit)
            var query = query_example;  // String |  (optional) 
            var filters[created] = 2013-10-20T19:20:30+01:00;  // Date |  (optional) 
            var filters[actorEmail][] = new array[String](); // array[String] |  (optional) 
            var filters[actorType] = filters[actorType]_example;  // String |  (optional) 
            var filters[auditableType] = filters[auditableType]_example;  // String |  (optional) 
            var filters[auditableUid] = filters[auditableUid]_example;  // String |  (optional) 
            var filters[verb] = filters[verb]_example;  // String |  (optional) 

            try
            {
                audit result = apiInstance.auditsSearchGet(scope, query, filters[created], filters[actorEmail][], filters[actorType], filters[auditableType], filters[auditableUid], filters[verb]);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuditsApi.auditsSearchGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuditsApi();
$scope = scope_example; // String | 
$query = query_example; // String | 
$filters[created] = 2013-10-20T19:20:30+01:00; // Date | 
$filters[actorEmail][] = ; // array[String] | 
$filters[actorType] = filters[actorType]_example; // String | 
$filters[auditableType] = filters[auditableType]_example; // String | 
$filters[auditableUid] = filters[auditableUid]_example; // String | 
$filters[verb] = filters[verb]_example; // String | 

try {
    $result = $api_instance->auditsSearchGet($scope, $query, $filters[created], $filters[actorEmail][], $filters[actorType], $filters[auditableType], $filters[auditableUid], $filters[verb]);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuditsApi->auditsSearchGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuditsApi;

my $api_instance = WWW::SwaggerClient::AuditsApi->new();
my $scope = scope_example; # String | 
my $query = query_example; # String | 
my $filters[created] = 2013-10-20T19:20:30+01:00; # Date | 
my $filters[actorEmail][] = []; # array[String] | 
my $filters[actorType] = filters[actorType]_example; # String | 
my $filters[auditableType] = filters[auditableType]_example; # String | 
my $filters[auditableUid] = filters[auditableUid]_example; # String | 
my $filters[verb] = filters[verb]_example; # String | 

eval { 
    my $result = $api_instance->auditsSearchGet(scope => $scope, query => $query, filters[created] => $filters[created], filters[actorEmail][] => $filters[actorEmail][], filters[actorType] => $filters[actorType], filters[auditableType] => $filters[auditableType], filters[auditableUid] => $filters[auditableUid], filters[verb] => $filters[verb]);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuditsApi->auditsSearchGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuditsApi()
scope = scope_example # String |  (optional) (default to audit)
query = query_example # String |  (optional)
filters[created] = 2013-10-20T19:20:30+01:00 # Date |  (optional)
filters[actorEmail][] =  # array[String] |  (optional)
filters[actorType] = filters[actorType]_example # String |  (optional)
filters[auditableType] = filters[auditableType]_example # String |  (optional)
filters[auditableUid] = filters[auditableUid]_example # String |  (optional)
filters[verb] = filters[verb]_example # String |  (optional)

try: 
    api_response = api_instance.audits_search_get(scope=scope, query=query, filters[created]=filters[created], filters[actorEmail][]=filters[actorEmail][], filters[actorType]=filters[actorType], filters[auditableType]=filters[auditableType], filters[auditableUid]=filters[auditableUid], filters[verb]=filters[verb])
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuditsApi->auditsSearchGet: %s\n" % e)

Parameters

Name	Description
scope	String
query	String
filters[created]	Date (date-time)
filters[actor_email][]	array[String]
filters[actor_type]	String
filters[auditable_type]	String
filters[auditable_uid]	String
filters[verb]	String

Responses

Status: 200

 {
  "object": {
    "pattern": "audit",
    "type": "string",
    "default": "audit"
  },
  "id": {
    "type": "string"
  },
  "actor_email": {
    "type": "string"
  },
  "auditable_type": {
    "type": "string"
  },
  "auditable_uid": {
    "type": "string"
  },
  "description": {
    "type": "string"
  },
  "created_at": {
    "type": "string",
    "format": "date-time"
  }
}